package org.jsola.contract.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.contract.dto.TemplateAddDTO;
import org.jsola.contract.dto.TemplatePreviewDTO;
import org.jsola.contract.dto.TemplateUpdateDTO;
import org.jsola.contract.query.TemplateQuery;
import org.jsola.contract.vo.TemplateListVO;
import org.jsola.contract.vo.TemplateVO;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.springframework.core.io.Resource;
import org.springframework.http.ResponseEntity;

import java.util.List;

/**
 * 合同模板
 *
 * @author JanusMix
 */
@Api(tags = "contract-合同模板")
public interface ITemplateControllerAPI {

    /**
     * 新增合同模板
     * @param templateAddDTO 合同模板新增实体
     * @return 合同模板展示对象
     */
    @ApiOperation(value = "新增合同模板")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateAddDTO", dataType = "TemplateAddDTO", value = "新增合同模板", paramType = "body")
    })
    Result<TemplateVO> save(TemplateAddDTO templateAddDTO);


    /**
     * 修改合同模板
     * @param templateUpdateDTO 合同模板
     * @return 更新数量
     */
    @ApiOperation(value = "修改合同模板")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateUpdateDTO", dataType = "TemplateUpdateDTO", value = "修改合同模板", paramType = "body")
    })
    Result<Integer> update(TemplateUpdateDTO templateUpdateDTO);




    /**
     * 删除单个合同模板，彻底删除
     * @param templateId 合同模板id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个合同模板，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateId", dataType = "Long", value = "合同模板id", paramType = "path")
    })
    Result<Integer> delete(Long templateId);


    /**
     * 批量删除合同模板，彻底删除
     * @param templateIds 合同模板id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除合同模板，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateIds", dataType = "Long[]", value = "合同模板id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] templateIds);


    /**
     * 根据合同模板id查询合同模板详情
     * @param templateId 合同模板id
     * @return 合同模板详情
     */
    @ApiOperation(value="根据合同模板id查询合同模板详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateId", dataType = "Long", value = "合同模板id", paramType = "path")
    })
    Result<TemplateVO> findById(Long templateId);


    /**
     * 查询合同模板
     * @param templateQuery 合同模板查询参数
     * @return page
     */
    @ApiOperation(value="查询合同模板")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateQuery", dataType = "TemplateQuery", value = "合同模板查询参数", paramType = "query")
    })
    Result<List<TemplateListVO>> listAll(TemplateQuery templateQuery);


     /**
     * 分页查询合同模板
     * @param templateQuery 合同模板查询参数
     * @return page
     */
    @ApiOperation(value="分页查询合同模板")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templateQuery", dataType = "TemplateQuery", value = "合同模板查询参数", paramType = "query")
    })
    Result<Page<TemplateListVO>> page(TemplateQuery templateQuery);

    @ApiOperation(value = "模板pdf预览")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templatePreviewDTO", value = "TemplatePreviewDTO", dataType = "预览对象", paramType = "body"),
    })
    ResponseEntity<Resource> viewFile(TemplatePreviewDTO templatePreviewDTO);

    @ApiOperation(value = "模板jpg预览")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templatePreviewDTO", value = "TemplatePreviewDTO", dataType = "预览对象", paramType = "body"),
    })
    ResponseEntity<Resource> viewJpgFile(TemplatePreviewDTO templatePreviewDTO);

    @ApiOperation(value = "模板jpg预览(该文件会上传到oss上，返回文件地址)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "templatePreviewDTO", value = "TemplatePreviewDTO", dataType = "预览对象", paramType = "body"),
    })
    Result<String> viewJpgPath(TemplatePreviewDTO templatePreviewDTO);

}

